bin/diff: Clarify documentation around REV and DIR syntax

Related: #2032

diff --git a/man/ostree-diff.xml b/man/ostree-diff.xml
index 10658cf21b659ec905ab7d828a98ae816a28c9ca..0b7ac89232ef85650ca13387a574f89ab06a56f7 100644 (file)
--- a/man/ostree-diff.xml
+++ b/man/ostree-diff.xml
@@ -51,7 +51,7 @@ Boston, MA 02111-1307, USA.
 
     <refsynopsisdiv>
             <cmdsynopsis>
-                <command>ostree diff</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">REV</arg> <arg choice="req">TARGETDIR</arg>
+              <command>ostree diff</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">REV_OR_DIR</arg> <arg choice="req">REV_OR_DIR</arg>
             </cmdsynopsis>
     </refsynopsisdiv>
 
@@ -59,7 +59,7 @@ Boston, MA 02111-1307, USA.
         <title>Description</title>
 
         <para>
-            Compare directory TARGETDIR against revision REV.  Shows files and directories modified, added, and deleted.  If there is a file in TARGETDIR not in REV, it will show with an "A" for "added".  If a file in REV is not in TARGETDIR, it shows "D" for "deleted".  "M" for "modified" will also show.
+          Compare a directory or revision against another directory or revision. If REV_OR_DIR starts with `/` or `./`, it is interpreted as a directory, otherwise a revision. Shows files and directories modified, added, and deleted.  If there is a file in the second REV_OR_DIR not in the first, it will show with an "A" for "added".  If a file in the first REV_OR_DIR is not in the second, it shows "D" for "deleted".  "M" for "modified" will also show.
         </para>
     </refsect1>
 

diff --git a/src/ostree/ot-builtin-diff.c b/src/ostree/ot-builtin-diff.c
index 1f0488de4b40f908783467e14069d9450c553d38..82a533d522c62171dfffaa816c76cb96791fd665 100644 (file)
--- a/src/ostree/ot-builtin-diff.c
+++ b/src/ostree/ot-builtin-diff.c
@@ -142,7 +142,7 @@ ostree_builtin_diff (int argc, char **argv, OstreeCommandInvocation *invocation,
   g_autoptr(GPtrArray) removed = NULL;
   g_autoptr(GPtrArray) added = NULL;
 
-  context = g_option_context_new ("REV TARGETDIR");
+  context = g_option_context_new ("REV_OR_DIR REV_OR_DIR");
 
   if (!ostree_option_context_parse (context, options, &argc, &argv, invocation, &repo, cancellable, error))
     goto out;